home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / os2 / csinst.zip / install.doc < prev    next >
Text File  |  1996-05-21  |  13KB  |  356 lines
  1. myNstall - the small PM installer
  2.  
  3. ======================================================================
  4. (c) Copyright Janosch R. Kowalczyk, 1996. 
  5.  
  6. This is myNstall the universal installation program from
  7. Janosch R. Kowalczyk.
  8.  
  9. All rights reserved. 
  10.  
  11. This program is Freeware. You can use this program for your own 
  12. private purposes, but you cannot change any of the contents with 
  13. following exeptions:
  14.   1. Contents of the file INSTALL.DAT.
  15.   2. You can use your own help file, but you MUST enclose 
  16.      following chapters from the existing INSTALL.HLP:
  17.  
  18.      - Author
  19.      - Author's thanks
  20.      - Copyright
  21.      - Disclaimer 
  22.      - Introduction
  23.  
  24. Please send all bug reports and improvement suggestions to the author .
  25. See chapter Author for details.
  26.  
  27. ----------------------------------------------------------------------
  28. 1. Introduction
  29.  
  30. The Release 1.0 and 1.01 Beta from myNstaller ([mju:]nstaller) has awaked a 
  31. lot of interest. That is why I decided to write the new release with many
  32. improvements.
  33.  
  34. This new release (1.02 beta) uses more control words and gives you the 
  35. interface to your own Rexx programs, so that you can design the installation 
  36. process with more flexibility as you are now able to. Of course you 
  37. can omit all these controls and work with the default values as delivered.
  38.  
  39. ----------------------------------------------------------------------
  40. 2. System requirements
  41.  
  42. myNstall requires approximately 140 kB of disk space. To use Greed to 
  43. install products,they must be the following on the computer:
  44.  
  45. - OS/2 version 2.x or higher,
  46.  
  47. - Rexx support.
  48.  
  49. ----------------------------------------------------------------------
  50. 3. How does the myNstaller work?
  51.  
  52.    To use the myNstall copy following files into your products source
  53.    (installation) directory:
  54.      - INSTALL.EXE
  55.      - INSTALL.HLP
  56.     [- INSTALL.DAT]
  57.    
  58.    INSTALL.DAT is the control file with the keywords to control your
  59.    installation process. You don't need this file, if you will not 
  60.    use its features. 
  61.  
  62.    The myNstall unpacks almost all files (with exception of files with
  63.    attributes H (hidden) and S (system) from the home (source) 
  64.    directory into the current destination directory.
  65.  
  66.    See OS/2 UNPACK command for more info. 
  67.  
  68.    Note: If the current destination directory does not exist, it will be 
  69.    created. You will be prompted for confirmation.
  70.  
  71.    The description of the WPS objects is situated in the file
  72.    INSTALL.DAT. The description records must be enclosed in
  73.    parenthesis ( ). If you will be creating a folder for other objects,
  74.    it must be placed at the beginning of the listing. For the syntax
  75.    see the parameter list of the REXX-function SysCreateObject.
  76.  
  77.    Note: You can only use one (1) line for one (1) description record.
  78.    i.e.:
  79.         /*------(start WPS objects)-----*/
  80.         ("WPFolder", title, location, associations, "r")
  81.         ("WPProgram", title, location, associations, "r")
  82.            other descriptions record
  83.            other descriptions record
  84.         /*------(end WPS objects)-----*/
  85.  
  86.    See chapter 5.5 in this file for more information.
  87.  
  88. ----------------------------------------------------------------------
  89. 4. Control word summary.
  90.  
  91.    The following are keywords to control the installation process:
  92.  
  93.     1. DESTINATION=destination_path
  94.     2. WPS_ONLY_IF_EXIST=file_name
  95.     3. WELCOME=welcome_message
  96.     4. WELCOME_TITLE=message_title
  97.     5. WELCOME_BUTTON={OK | OKCANCEL}
  98.     6. START_REXX_BY_OPEN_WINDOW=rexxcall
  99.     7. START_REXX_BY_START_INSTALL=rexxcall
  100.     8. START_REXX_BY_SUCCESSFUL=rexxcall 
  101.     9. START_REXX_BY_FAILURE=rexxcall 
  102.    10. START_REXX_BY_CLOSE_WINDOW=rexxcall
  103.    11. DEST_PATH (used by SysCreateObject and your own Rexx)
  104.    12. HOMEDIR (to be used by your own Rexx)
  105.    13. DELETE_FILE
  106.    14. REMOVE_DIR
  107.    15. DELETE_FILE_AFTER_INSTALLATION
  108.    16. REMOVE_DIR_AFTER_INSTALLATION
  109.  
  110. ----------------------------------------------------------------------
  111. 5. Control words (keywords).
  112.  
  113. You can write the keywords into the file INSTALL.DAT in any order!
  114.  
  115. The follwing describes keywords which you can use in the control file 
  116. INSTALL.DAT (remember you can omit all these controls!):
  117.  
  118.   1. DESTINATION=destination_path
  119.  
  120.      The keyword DESTINATION=destination_directory_path identifies the 
  121.      record from file INSTALL.DAT which sets the name of the standard
  122.      destination directory.
  123.      If you omit this name, the root directory of the drive C: will be 
  124.      used.
  125.      You should omit the leading and ending backslashes and the drive
  126.      character.
  127.  
  128.      Default value: root directory of the drive C: (drive C: is always
  129.      the default drive. Everybody has the drive C: - isn't?).
  130.  
  131.      Example:
  132.      DESTINATION=TOOLS\INSTALL
  133.  
  134.  
  135.   2. WPS_ONLY_IF_EXIST=file_name
  136.  
  137.      The Installer is able to recreate the damaged WPS-Objects for your 
  138.      installation. It does this, if the Check Box "Create WPS objects
  139.      only" is selected. But it is not necessary to enable this box 
  140.      if the user is doing his first installation. You can disable this 
  141.      Check Box for the installation window, if you use this keyword. 
  142.      This box will be enabled, if the file 'file_name' is present in the 
  143.      destination directory AND the source directory is equal to the 
  144.      destination directory.
  145.      
  146.      Default value: no - the check box will be enabled
  147.  
  148.      Example:
  149.      WPS_ONLY_IF_EXIST=GREED.EXE
  150.  
  151.  
  152.   3. WELCOME keywords
  153.      These keywords help you to personify the start of the install procedure.
  154.      There are 3 WELCOME-keywords :
  155.      
  156.      1. WELCOME=welcome_message
  157.         This keyword allows you to show the text of welcome_message before
  158.         your installation starts. You can use multiple WELCOME= keywords
  159.         for one message. Each WELCOME= message gives you a new line in the
  160.         message box. Additionally  you can use '\n' (like C) in the message
  161.         line for Line Feed. 
  162.         Note: You must have used at least one WELCOME= message  
  163.         before you can use the WELCOME_TITLE and WELCOME_BUTTON
  164.         keywords.
  165.         
  166.         Default value: No - no message box.
  167.         
  168.         Example:
  169.         WELCOME=Welcome to the Installation of "GREED"\nVersion 2.0 Beta.\n\n
  170.         WELCOME=Click OK to continue or CANCEL to exit\n\n
  171.         
  172.      2. WELCOME_TITLE=message_title
  173.         You can use this keyword to change the title in the message box
  174.  
  175.         Default value: Welcome
  176.  
  177.         Example:
  178.         WELCOME_TITLE=Hallo folks!
  179.  
  180.      3. WELCOME_BUTTON={OK | OKCANCEL}
  181.         The message box, in which you show your info, can have either an OK button
  182.         or both OK and CANCEL buttons. You can decide which form you will use.  
  183.         
  184.         Default value: OKCANCEL
  185.  
  186.         Example:
  187.         WELCOME_BUTTON=OK
  188.  
  189.      Note: Set message text without apostrophes.
  190.  
  191.  
  192.   4. Keywords for call of Rexx procedures
  193.  
  194.      myNstall Ver. 1.01 Beta supplies the possibility to call your own Rexx
  195.      procedures at 5 different points of installation processing:
  196.  
  197.      1. START_REXX_BY_OPEN_WINDOW=rexxcall - before the start of the
  198.         installation (pre-processing exit).
  199.         
  200.         Default value: No - no rexx will be called.
  201.  
  202.         Example:
  203.         START_REXX_BY_OPEN_WINDOW=my1rexx 'Janosch'
  204.  
  205.      2. START_REXX_BY_START_INSTALL=rexxcall - after pressing  the
  206.         Push Button "Install" (pre-install exit).
  207.         
  208.         Default value: No - no rexx will be called.
  209.  
  210.         Example:
  211.         START_REXX_BY_START_INSTALL=my2rexx
  212.  
  213.      3. START_REXX_BY_SUCCESSFUL=rexxcall - after successfull 
  214.           installation (post-install successful exit).
  215.      
  216.         Default value: No - no rexx will be called.
  217.  
  218.         Example:
  219.         START_REXX_BY_SUCCESSFUL=my3rexx 'A:'
  220.  
  221.      4. START_REXX_BY_FAILURE=rexxcall - after the unsuccessfull 
  222.           installation (post-install failure exit).
  223.      
  224.         Default value: No - no rexx will be called.
  225.  
  226.         Example:
  227.         START_REXX_BY_FAILURE=my4rexx
  228.  
  229.      5. STAR